home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / program / yawpi11.zip / YAWPI.TXT < prev   
Text File  |  1995-09-27  |  14KB  |  430 lines
  1.                  YAWPI: Yet Another Windows Program Installer
  2.          ============================================
  3.  
  4.                                Version 1.1 
  5.                                ===========
  6.                                                 Version 1.1
  7.  
  8.  
  9. 1. Introduction
  10. _______________
  11.  
  12. YAWPI is a simple yet powerful and elegant Windows installation program.
  13. It features user selection of destination directory, full screen main window
  14. with color gradient (similar to MS-Setup) and display of meter bar
  15. (progress bar) for each program disk as well as numeric percentage progress
  16. per file or archive.
  17.  
  18. YAWPI can copy files and uncompress archives (as well as nested archives)
  19. into subdirectories or the Windows directory. The decompression code is 
  20. integrated in INSTALL.EXE. That means that you can compress your application 
  21. very tightly without paying royalties for compression software.
  22.  
  23. The source directory can be on the hard drive or on floppy drive. Multiple
  24. floppy diskettes are supported, as well as multiple .zip files distributed
  25. through BBS's and the Internet.
  26.  
  27. The installation parameters are set by defining variables in a simple syntax
  28. similar to .INI files (i.e. Variable=Value). No scripts and no fancy script
  29. editors and generators - simply edit a few short text files - that's all
  30. there is to it!! If you start from the supplied samples you can have a
  31. complete package in half an hour.
  32.  
  33.  
  34. 2. Registration
  35. _______________
  36.  
  37. YAWPI is a shareware product. It means that you must register before 
  38. using this software to distribute your application.
  39.  
  40. The unregistered version has all the functionally of the registered version
  41. so you can prepare your configuration files and test the installation
  42. process before registering. However, the unregistered version displays
  43. the message "YAWPI - Unregistered Version" on the caption bar.
  44.  
  45. With QUICK registration you simply receive a registration password that
  46. matches your name. As soon as you enter your name and password to the
  47. 'Register' dialog of the Seal editor, you can set the title of the
  48. caption bar to whatever you choose.
  49.  
  50. Your password will work with future versions of YAWPI, so you can upgrade
  51. by simply downloading the latest version. Read the instructions at the
  52. end of this file on where to get the latest version.
  53.  
  54. With FULL registration you will receive the full source code (C and C++)
  55. of YAWPI and AR, so you will be free to further fine tune it according
  56. to your needs.
  57.  
  58. Edit the file "register.frm" (or click on the "Register" icon), fill in
  59. the details and send it with your payment by E-mail, fax of S-mail.
  60.  
  61. 3. Windows 95
  62. _____________
  63.  
  64. This version of YAWPI was compiled for Windows 3.1. It works well under
  65. Windows 95 but does not support long file names or long directory names
  66. (folders, that is...).
  67.  
  68. INSTALL.EXE may be renamed to SETUP.EXE (or ANYTHING.EXE).
  69.  
  70.  
  71. 4. Compressed Archives
  72. ______________________
  73.  
  74. YAWPI supports archives compressed by the AR freeware utility. AR is not
  75. compatible with PKZIP but achieves almost the same compression rate.
  76. This is *far* better than using Microsoft COMPRESS on individual files.
  77.  
  78. AR is freeware and is available with C source. The DOS based AR.EXE
  79. is included in this package.
  80.  
  81. If your application uses a large number of small files you can save upto 15%
  82. of the space by using nested archives. The extra saving comes from the fact
  83. that compression algorithms work better on large files. You first combine
  84. your small files into one large *uncompressed* archive, then compress
  85. that file into a container archive. Here is how you do it with AR:
  86.  
  87.     AR s myprog.ar files*.*
  88.     AR a myprog.arr myprog.ar
  89.  
  90. "myprog.arr" is smaller than "myprog.ar" created by:
  91.  
  92.     AR a myprog.ar files*.*
  93.  
  94. If you mark "myprog.arr" as a nested archive, YAWPI will perform
  95. the following steps during installation:
  96.  
  97.         1. Extract "myprog.ar" from "myprog.arr".
  98.         2. Extract "files*.*" from "myprog.ar".
  99.         3. Delete "myprog.ar".
  100.  
  101. Notes:
  102.  
  103.         1. AR always saves and restores the file paths in the archive. This
  104.            is equivalent to "pkzip -P" and "pkunzip -d".
  105.         2. To create a nested archive with pkzip use the following steps:
  106.  
  107.            pkzip -e0 myprog.zip files*.*
  108.            pkzip myprog1.zip myprog.zip
  109.  
  110.  
  111. 5. INSTALL.CFG
  112. ______________
  113.  
  114. This file must be located on the first floppy disk (or in a subdirectory of
  115. the hard drive) together with "install.exe" (or "setup.exe").
  116.  
  117. It controls the look and contents of the main installation window.
  118. The following sections describe the variables that you can define in order
  119. to customize YAWPI for your application.
  120.  
  121.  
  122. 5.1 ProgramName
  123.  
  124. Defines the name of the program being installed.
  125.  
  126. Example: ProgramName=Magic Graphics
  127.  
  128.  
  129. 5.2 DefaultPath
  130.  
  131. Defines the default destination path for installing the program.
  132.  
  133. Example: DefaultPath=C:\MGRAPHIC
  134.  
  135.  
  136. 5.3 Title1
  137.  
  138. A centered title line at the top of the main window.
  139.  
  140. Example: Title1=Magic Graphics
  141.  
  142. 5.4 Title1Size
  143.  
  144. Size of Title1 in points. This number is converted to pixels depending on
  145. the screen resolution. Use 50 points for large letters, 20 points for small
  146. letters, or any number in between.
  147.  
  148. Example: Title1Size=25
  149.  
  150. 5.5 Title1Color
  151.  
  152. Color of Title1 in RGB.
  153.  
  154. Example: Title1Color=30 187 0
  155.  
  156.  
  157. 5.6 Title2, Title2Size, Title2Color
  158.  
  159. Same as Title1. This is a second title line.
  160.  
  161. 5.7 TitleShadeColor
  162.  
  163. Color of shade for Title1 and Title2 in RGB.
  164.  
  165. Example: TitleShadeColor=0 0 0
  166.  
  167. 5.8 TopColor, BottomColor
  168.  
  169. Define the background color at the top and bottom of the main window.
  170. You can get a solid background by setting TopColor and BottomColor to the
  171. same value. If TopColor is different than Bottom Color you get
  172. a color gradient.
  173.  
  174. Example:
  175.  
  176.         TopColor=0 76 38
  177.         BottomColor=51 204 102
  178.  
  179. 5.9 NumGradientSteps
  180.  
  181. Defines the number of color gradient steps. This number should not exceed 200.
  182.  
  183. Example: NumGradientSteps=32
  184.  
  185. 5.10 DirExistsWarn
  186.  
  187. If defined to "Y" (by default), YAWPI will warn the user if the destination
  188. directory already exists. To suppress this warning, define this variable
  189. to "N".
  190.  
  191. Example: DirExistsWarn=N
  192.  
  193. 5.11 DirNotFoundWarn
  194.  
  195. If defined to "Y", YAWPI will warn the user if the destination directory
  196. is *not* found. This is useful for installation of upgrade versions or
  197. separate components of a larger software package.
  198.  
  199. The default option is DirNotFoundWarn=N
  200.  
  201.  
  202. 5.12 Caption
  203.  
  204. Sets the caption of the main window.
  205.  
  206. Example: Caption=Magic Graphics Installation
  207.  
  208. Note: This variable works only in the REGISTERED VERSION of YAWPI.
  209.  
  210. 5.13 Username
  211.  
  212. Registered user name, or developer of the application. This variable is
  213. entered automatically by the Seal editor.
  214.  
  215. 5.14 Seal
  216.  
  217. This variable is entered automatically by the Seal editor. It is an
  218. encrypted checksum of all the INSTALL.CFG variables described above.
  219.  
  220. The purpose of the Seal variable is to prevent your users from pirating
  221. your registered version of YAWPI. If anyone modifies INSTALL.CFG without
  222. Sealing it again, YAWPI will display the "Unregistered Version" message
  223. on the caption bar.
  224.  
  225. 6. Disk Sections
  226. ________________
  227.  
  228. Following all the variables described above are the disk sections.
  229. Each floppy disk has a section with a title of the form [Disk1] [Disk2] etc.
  230. The section title must be on a separate line.
  231.  
  232. Within each disk section you list the files or archives on the disk.
  233.  
  234.  
  235. 6.1 Plain (uncompressed) Files
  236.  
  237. Define each uncompressed file to be copied to the destination directory
  238. with the syntax:
  239.  
  240. <file>==<destination>
  241.  
  242. If <destination> contains the term "$d", it is substituted by the destination
  243. path.
  244.  
  245. If <destination> contains the term "$w", it is substituted by the user's
  246. Windows directory.
  247.  
  248. Example: PICTURE.DAT==$d\DATA
  249.  
  250. Will copy the file PICTURE.DAT to C:\MGRAPHIC\DATA. If the user had changed
  251. the default C:\MGRAPHIC to D:\MG, the file will be copied to D:\MG\DATA.
  252.  
  253. Example: MYPROG.INI==$w
  254.  
  255. Will copy the file MYPROG.INI to Windows directory (usually C:\WINDOWS).
  256.  
  257. 6.2 Compressed Archives
  258.  
  259. Define each compressed archive with the syntax:
  260.  
  261. <archive>=<destination>
  262.  
  263. Example: MYPROG.AR=$d\BIN
  264.  
  265. Will extract the contents of MYPROG.AR to C:\MGRAPHIC\BIN.
  266.  
  267. 6.3 Nested Archives
  268.  
  269. Define each nested archive with the syntax:
  270.  
  271. <archive>=@<destination>
  272.  
  273. Example: MYPROG.ARR=@$d
  274.  
  275. Will first extract MYPROG.AR from MYPROG.ARR. Then extract the contents of
  276. MYPROG.AR into the destination directory. Finally, MYPROG.AR is deleted.
  277.  
  278. Important Note: The container archive must contain a single archive with
  279. the same base name as the nested archive, and same extension truncated
  280. to two letters.
  281.  
  282. Examples:
  283.  
  284.         MYPROG.ARR contains MYPROG.AR
  285.         YR_PROG.XYZ contains YR_PROG.XY
  286.  
  287. Read section 2 of this document again to see how to create nested archives.
  288.  
  289. 7. THISDISK
  290. ___________
  291.  
  292. If you distribute your application on multiple floppy disks, you must
  293. place a THISDISK file on each floppy. YAWPI uses THISDISK files to verify
  294. that the correct floppy disk is in the drive.
  295.  
  296. 7.1 DiskNumber
  297.  
  298. Defines the disk number, starting with 1.
  299.  
  300. Example: DiskNumber=1
  301.  
  302. 7.2 NextDiskNumber
  303.  
  304. Defines the next distribution disk for your application. On the last disk,
  305. do not define this variable (or define it to 0).
  306.  
  307. Example: NextDiskNumber=2
  308.  
  309.  
  310. Notes: If your application fits on a single floppy or when installing from
  311. the hard drive (drive C: or higher), THISDISK files are ignored. If your
  312. application consists of multiple .ZIP files, the user should unzip them into
  313. one subdirectory. All the [Disk*] sections are then merged into one "disk"
  314. at installation time, so the user will not be prompted for the next disk.
  315.  
  316.  
  317. 8. WIN.INI, SYSTEM.INI
  318. ______________________
  319.  
  320. If you need to add or modify a section in WIN.INI or SYSTEM.INI in the user's
  321. Windows directory, simply place these files with your modifications on the
  322. distribution diskette. You can use "$d" and "$w" within your WIN.INI.
  323. These symbols are substituted before being added to Windows WIN.INI.
  324.  
  325. Sample WIN.INI:
  326.  
  327.         [windows]
  328.         ScreenSaveActive=1
  329.  
  330.         [Magic Screen Saver]
  331.         MagicDir=$d
  332.         Settings=0 0 3 5
  333.  
  334.  
  335. Important Note : Do not list WIN.INI and SYSTEM.INI files in INSTALL.CFG
  336. [Disk*] sections or else they will *replace* the files in Windows directory.
  337.  
  338.  
  339. 9. GROUPS.CFG
  340. _____________
  341.  
  342. This file defines the program group and icons to be added to the user's 
  343. desktop.
  344.  
  345. 9.1 Group
  346.  
  347. Defines the name of the program group where the icons will be added.
  348.  
  349. Example: Group=Magic Applications Group
  350.  
  351. 9.2 Item1, Item2 ...
  352.  
  353. Defines the icons in the selected group.
  354.  
  355. Example: Item1=$d\myprog.exe,Magic Grahpics,$d\myprog.exe,1
  356. Example: Item2=$w\notepad.exe $d\register.frm,Register
  357. Example: Item3=$d\dosapp.exe,Dos Magic,$d\dosapp.ico
  358.  
  359. Each definition line consists of up to 4 parameters separated by commas.
  360. The first parameter defines the command line for starting the program.
  361. The second parameter defines the title under the icon.
  362. The third (optional) parameter defines the file that contains the icon.
  363. The fourth (optional) parameter defines the icon number within the file.
  364.  
  365. 10. Seal Editor
  366. _______________
  367.  
  368. The Seal editor is a standard text editor with one additional feature -
  369. it seals INSTALL.CFG files.
  370.  
  371. If you are a registered user of YAWPI you should enter your name and
  372. registration password to the Seal editor. From the 'File' menu select
  373. 'Register' and enter the information to the Register dialog.
  374.  
  375. After you have finished preparing the INSTALL.CFG file, start the Seal
  376. editor and open INSTALL.CFG of your application. From the 'File'
  377. menu select 'Save and Seal'. It will save any editing changes you have 
  378. made to the file and add your name and a special "seal" to INSTALL.CFG.
  379.  
  380. The seal enables the 'Caption' variable so YAWPI will display your
  381. selected caption instead of "Unregistered Version" message.
  382.  
  383. The seal is unique to each INSTALL.CFG. It is generated as an encrypted 
  384. checksum of all the variables in in the file, not including [Disk*] 
  385. sections. Therefore you have to seal INSTALL.CFG every time you modify 
  386. the title or color of the main screen. There is no need to seal again
  387. when you add or remove files for installation.
  388.  
  389. This feature guarantees that your users cannot pirate the registered version
  390. of YAWPI and use it to install another application.
  391.  
  392. Note: do not distribute SEAL.EXE with your application.
  393.  
  394.  
  395. 11. Comparison with Previous Versions
  396. _____________________________________
  397.  
  398. If you have upgraded from version 1.00 or 1.01 read this section.
  399.  
  400. 11.1 Password
  401.  
  402. Do not put your registration password in INSTALL.CFG. Instead, use the 
  403. Seal editor as explained in section 10. The password you received 
  404. is still valid.
  405.  
  406. 11.2 THISDISK
  407.  
  408. For backwards compatibility, files and archives can be listed in THISDISK
  409. instead of INSTALL.CFG. If you choose this way, do not put any [Disk*] 
  410. sections in INSTALL.CFG.
  411.  
  412. The only case in which you have to list your files and archives in 
  413. INSTALL.CFG is when you distribute your application in multiple .ZIP files
  414. which the user unzips into one subdirectory. The individual THISDISK files
  415. then overwrite each other and if they contain file/archive information,
  416. some of it is lost.
  417.  
  418. 12. The Lastest Version
  419. ______________________
  420.  
  421. Check the following locations:
  422.  
  423.         1. CompuServe: GO ASPFORUM, library 5 (PC Authors).
  424.         2. By ftp: ftp.magic.ca /rtls/misc
  425.         3. WWW: http://www.execpc.com/~rtls
  426.  
  427.  
  428.  
  429.  
  430.